SharedAPI Methods

An object defining methods for the SharedAPI class.

SetUrl(url)

Sets the API URL for requests.

Parameters:

url (required): string
The new API URL.

Returns:

Type: void
Method does not return anything

Exceptions:

Type: ArgumentNullException
Throws ArgumentNullException if URL is null or empty.

Type: Exception
Throws Exception if the URL is invalid.

This is a sync method. Method runs synchronously.

---

CreateLink(data, telemetryCollectorHolder)

The CreateLink() method is responsible for generating shareable links based on the specified request data. This method allows for creating links that can be used to perform various actions such as starting a process, filling out forms, or accessing specific items or pages within the system. The method supports customization through several parameters, including the ability to limit the number of accesses, control the display of embedded views, and define access permissions based on the user, link status, expiration date, and language. Additionally, it allows hiding specific UI elements through the ViewHideInfo parameter and can be tied to a delegation through the DelegationId.

Parameters:

data (required): CreateLinkRequest
Parameters required for creating shared link.

telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data. This property is advance using only.

Returns:

Type: Task<WrapResponse<CreateLinkResponse>>
Newly created link as CreateLinkResponse object wrapped with WrapResponse class.

This is a async method. Method should be waited. Be careful if call this method without waiting.

See Also

• Async/Await Usage